<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkPlacesSidebar: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="SelectorWidgets.html" title="Selector Widgets and Dialogs">
<link rel="prev" href="GtkFontChooserDialog.html" title="GtkFontChooserDialog">
<link rel="next" href="Ornaments.html" title="Ornaments">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkPlacesSidebar.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkPlacesSidebar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkPlacesSidebar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkPlacesSidebar.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkPlacesSidebar.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="SelectorWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkFontChooserDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Ornaments.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkPlacesSidebar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkPlacesSidebar.top_of_page"></a>GtkPlacesSidebar</span></h2>
<p>GtkPlacesSidebar — Sidebar that displays frequently-used places in the file system</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="placessidebar.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkPlacesSidebar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-new" title="gtk_places_sidebar_new ()">gtk_places_sidebar_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-open-flags" title="gtk_places_sidebar_set_open_flags ()">gtk_places_sidebar_set_open_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="returnvalue">GtkPlacesOpenFlags</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-open-flags" title="gtk_places_sidebar_get_open_flags ()">gtk_places_sidebar_get_open_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-location" title="gtk_places_sidebar_set_location ()">gtk_places_sidebar_set_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GFile</span> *
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-location" title="gtk_places_sidebar_get_location ()">gtk_places_sidebar_get_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-recent" title="gtk_places_sidebar_set_show_recent ()">gtk_places_sidebar_set_show_recent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-show-recent" title="gtk_places_sidebar_get_show_recent ()">gtk_places_sidebar_get_show_recent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-desktop" title="gtk_places_sidebar_set_show_desktop ()">gtk_places_sidebar_set_show_desktop</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-show-desktop" title="gtk_places_sidebar_get_show_desktop ()">gtk_places_sidebar_get_show_desktop</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-add-shortcut" title="gtk_places_sidebar_add_shortcut ()">gtk_places_sidebar_add_shortcut</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-remove-shortcut" title="gtk_places_sidebar_remove_shortcut ()">gtk_places_sidebar_remove_shortcut</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-list-shortcuts" title="gtk_places_sidebar_list_shortcuts ()">gtk_places_sidebar_list_shortcuts</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GFile</span> *
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-nth-bookmark" title="gtk_places_sidebar_get_nth_bookmark ()">gtk_places_sidebar_get_nth_bookmark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-show-connect-to-server" title="gtk_places_sidebar_get_show_connect_to_server ()">gtk_places_sidebar_get_show_connect_to_server</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-connect-to-server" title="gtk_places_sidebar_set_show_connect_to_server ()">gtk_places_sidebar_set_show_connect_to_server</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-local-only" title="gtk_places_sidebar_get_local_only ()">gtk_places_sidebar_get_local_only</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-local-only" title="gtk_places_sidebar_set_local_only ()">gtk_places_sidebar_set_local_only</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-show-enter-location" title="gtk_places_sidebar_get_show_enter_location ()">gtk_places_sidebar_get_show_enter_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-enter-location" title="gtk_places_sidebar_set_show_enter_location ()">gtk_places_sidebar_set_show_enter_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-show-trash" title="gtk_places_sidebar_get_show_trash ()">gtk_places_sidebar_get_show_trash</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-trash" title="gtk_places_sidebar_set_show_trash ()">gtk_places_sidebar_set_show_trash</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-show-other-locations" title="gtk_places_sidebar_get_show_other_locations ()">gtk_places_sidebar_get_show_other_locations</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-other-locations" title="gtk_places_sidebar_set_show_other_locations ()">gtk_places_sidebar_set_show_other_locations</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-drop-targets-visible" title="gtk_places_sidebar_set_drop_targets_visible ()">gtk_places_sidebar_set_drop_targets_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--local-only" title="The “local-only” property">local-only</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">GFile</span> *</td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--location" title="The “location” property">location</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--open-flags" title="The “open-flags” property">open-flags</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--populate-all" title="The “populate-all” property">populate-all</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-connect-to-server" title="The “show-connect-to-server” property">show-connect-to-server</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-desktop" title="The “show-desktop” property">show-desktop</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-enter-location" title="The “show-enter-location” property">show-enter-location</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-other-locations" title="The “show-other-locations” property">show-other-locations</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-recent" title="The “show-recent” property">show-recent</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-starred-location" title="The “show-starred-location” property">show-starred-location</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar--show-trash" title="The “show-trash” property">show-trash</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">int</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-drag-action-ask" title="The “drag-action-ask” signal">drag-action-ask</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">int</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-drag-action-requested" title="The “drag-action-requested” signal">drag-action-requested</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-drag-perform-drop" title="The “drag-perform-drop” signal">drag-perform-drop</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-mount" title="The “mount” signal">mount</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal">open-location</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-populate-popup" title="The “populate-popup” signal">populate-popup</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-connect-to-server" title="The “show-connect-to-server” signal">show-connect-to-server</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-enter-location" title="The “show-enter-location” signal">show-enter-location</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-error-message" title="The “show-error-message” signal">show-error-message</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-other-locations" title="The “show-other-locations” signal">show-other-locations</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-other-locations-with-flags" title="The “show-other-locations-with-flags” signal">show-other-locations-with-flags</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-starred-location" title="The “show-starred-location” signal">show-starred-location</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-unmount" title="The “unmount” signal">unmount</a></td>
<td class="signal_flags">Run First</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-struct" title="GtkPlacesSidebar">GtkPlacesSidebar</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags">GtkPlacesOpenFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
            <span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
                <span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
                    <span class="lineart">╰──</span> <a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow">GtkScrolledWindow</a>
                        <span class="lineart">╰──</span> GtkPlacesSidebar
</pre>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkPlacesSidebar implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.description"></a><h2>Description</h2>
<p><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> is a widget that displays a list of frequently-used places in the
file system:  the user’s home directory, the user’s bookmarks, and volumes and drives.
This widget is used as a sidebar in <a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a> and may be used by file managers
and similar programs.</p>
<p>The places sidebar displays drives and volumes, and will automatically mount
or unmount them when the user selects them.</p>
<p>Applications can hook to various signals in the places sidebar to customize
its behavior.  For example, they can add extra commands to the context menu
of the sidebar.</p>
<p>While bookmarks are completely in control of the user, the places sidebar also
allows individual applications to provide extra shortcut folders that are unique
to each application.  For example, a Paint program may want to add a shortcut
for a Clipart folder.  You can do this with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-add-shortcut" title="gtk_places_sidebar_add_shortcut ()"><code class="function">gtk_places_sidebar_add_shortcut()</code></a>.</p>
<p>To make use of the places sidebar, an application at least needs to connect
to the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a> signal.  This is emitted when the
user selects in the sidebar a location to open.  The application should also
call <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-location" title="gtk_places_sidebar_set_location ()"><code class="function">gtk_places_sidebar_set_location()</code></a> when it changes the currently-viewed
location.</p>
<div class="refsect2">
<a name="id-1.3.14.16.10.7"></a><h3>CSS nodes</h3>
<p>GtkPlacesSidebar uses a single CSS node with name placessidebar and style
class .sidebar.</p>
<p>Among the children of the places sidebar, the following style classes can
be used:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>.sidebar-new-bookmark-row for the 'Add new bookmark' row</p></li>
<li class="listitem"><p>.sidebar-placeholder-row for a row that is a placeholder</p></li>
<li class="listitem"><p>.has-open-popup when a popup is open for a row</p></li>
</ul></div>
</div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-places-sidebar-new"></a><h3>gtk_places_sidebar_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_places_sidebar_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> widget.</p>
<p>The application should connect to at least the
<a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a> signal to be notified
when the user makes a selection in the sidebar.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-new.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-open-flags"></a><h3>gtk_places_sidebar_set_open_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_open_flags (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                   <em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> flags</code></em>);</pre>
<p>Sets the way in which the calling application can open new locations from
the places sidebar.  For example, some applications only open locations
“directly” into their main view, while others may support opening locations
in a new notebook tab or a new window.</p>
<p>This function is used to tell the places <em class="parameter"><code>sidebar</code></em>
 about the ways in which the
application can open new locations, so that the sidebar can display (or not)
the “Open in new tab” and “Open in new window” menu items as appropriate.</p>
<p>When the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a> signal is emitted, its flags
argument will be set to one of the <em class="parameter"><code>flags</code></em>
 that was passed in
<a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-open-flags" title="gtk_places_sidebar_set_open_flags ()"><code class="function">gtk_places_sidebar_set_open_flags()</code></a>.</p>
<p>Passing 0 for <em class="parameter"><code>flags</code></em>
 will cause <a class="link" href="GtkPlacesSidebar.html#GTK-PLACES-OPEN-NORMAL:CAPS"><span class="type">GTK_PLACES_OPEN_NORMAL</span></a> to always be sent
to callbacks for the “open-location” signal.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-open-flags.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Bitmask of modes in which the calling application can open locations</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-open-flags"></a><h3>gtk_places_sidebar_get_open_flags ()</h3>
<pre class="programlisting"><a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="returnvalue">GtkPlacesOpenFlags</span></a>
gtk_places_sidebar_get_open_flags (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Gets the open flags.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-open-flags.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-open-flags.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> of <em class="parameter"><code>sidebar</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-location"></a><h3>gtk_places_sidebar_set_location ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_location (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                 <em class="parameter"><code><span class="type">GFile</span> *location</code></em>);</pre>
<p>Sets the location that is being shown in the widgets surrounding the
<em class="parameter"><code>sidebar</code></em>
, for example, in a folder view in a file manager.  In turn, the
<em class="parameter"><code>sidebar</code></em>
 will highlight that location if it is being shown in the list of
places, or it will unhighlight everything if the <em class="parameter"><code>location</code></em>
 is not among the
places in the list.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>location to select, or <code class="literal">NULL</code> for no current path. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-location"></a><h3>gtk_places_sidebar_get_location ()</h3>
<pre class="programlisting"><span class="returnvalue">GFile</span> *
gtk_places_sidebar_get_location (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Gets the currently selected location in the <em class="parameter"><code>sidebar</code></em>
. This can be <code class="literal">NULL</code> when
nothing is selected, for example, when <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-location" title="gtk_places_sidebar_set_location ()"><code class="function">gtk_places_sidebar_set_location()</code></a> has
been called with a location that is not among the sidebar’s list of places to
show.</p>
<p>You can use this function to get the selection in the <em class="parameter"><code>sidebar</code></em>
.  Also, if you
connect to the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-populate-popup" title="The “populate-popup” signal"><span class="type">“populate-popup”</span></a> signal, you can use this
function to get the location that is being referred to during the callbacks
for your menu items.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-location.returns"></a><h4>Returns</h4>
<p>a <span class="type">GFile</span> with the selected location, or
<code class="literal">NULL</code> if nothing is visually selected. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-show-recent"></a><h3>gtk_places_sidebar_set_show_recent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_show_recent (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                    <em class="parameter"><code><span class="type">gboolean</span> show_recent</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should show an item for recent files.
The default value for this option is determined by the desktop
environment, but this function can be used to override it on a
per-application basis.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-show-recent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_recent</p></td>
<td class="parameter_description"><p>whether to show an item for recent files</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-show-recent"></a><h3>gtk_places_sidebar_get_show_recent ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_show_recent (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-recent" title="gtk_places_sidebar_set_show_recent ()"><code class="function">gtk_places_sidebar_set_show_recent()</code></a></p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-recent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-recent.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will display a builtin shortcut for recent files</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-show-desktop"></a><h3>gtk_places_sidebar_set_show_desktop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_show_desktop (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                     <em class="parameter"><code><span class="type">gboolean</span> show_desktop</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should show an item for the Desktop folder.
The default value for this option is determined by the desktop
environment and the user’s configuration, but this function can be
used to override it on a per-application basis.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-show-desktop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_desktop</p></td>
<td class="parameter_description"><p>whether to show an item for the Desktop folder</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-show-desktop"></a><h3>gtk_places_sidebar_get_show_desktop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_show_desktop (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-desktop" title="gtk_places_sidebar_set_show_desktop ()"><code class="function">gtk_places_sidebar_set_show_desktop()</code></a></p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-desktop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-desktop.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will display a builtin shortcut to the desktop folder.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-add-shortcut"></a><h3>gtk_places_sidebar_add_shortcut ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_add_shortcut (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                 <em class="parameter"><code><span class="type">GFile</span> *location</code></em>);</pre>
<p>Applications may want to present some folders in the places sidebar if
they could be immediately useful to users.  For example, a drawing
program could add a “/usr/share/clipart” location when the sidebar is
being used in an “Insert Clipart” dialog box.</p>
<p>This function adds the specified <em class="parameter"><code>location</code></em>
 to a special place for immutable
shortcuts.  The shortcuts are application-specific; they are not shared
across applications, and they are not persistent.  If this function
is called multiple times with different locations, then they are added
to the sidebar’s list in the same order as the function is called.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-add-shortcut.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>location to add as an application-specific shortcut</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-remove-shortcut"></a><h3>gtk_places_sidebar_remove_shortcut ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_remove_shortcut (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                    <em class="parameter"><code><span class="type">GFile</span> *location</code></em>);</pre>
<p>Removes an application-specific shortcut that has been previously been
inserted with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-add-shortcut" title="gtk_places_sidebar_add_shortcut ()"><code class="function">gtk_places_sidebar_add_shortcut()</code></a>.  If the <em class="parameter"><code>location</code></em>
 is not a
shortcut in the sidebar, then nothing is done.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-remove-shortcut.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>location to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-list-shortcuts"></a><h3>gtk_places_sidebar_list_shortcuts ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *
gtk_places_sidebar_list_shortcuts (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Gets the list of shortcuts.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-list-shortcuts.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-list-shortcuts.returns"></a><h4>Returns</h4>
<p>A <span class="type">GSList</span> of <span class="type">GFile</span> of the locations that have been added as
application-specific shortcuts with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-add-shortcut" title="gtk_places_sidebar_add_shortcut ()"><code class="function">gtk_places_sidebar_add_shortcut()</code></a>.
To free this list, you can use</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="n">g_slist_free_full</span> <span class="p">(</span><span class="n">list</span><span class="p">,</span> <span class="p">(</span><span class="n">GDestroyNotify</span><span class="p">)</span> <span class="n">g_object_unref</span><span class="p">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GFile][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-nth-bookmark"></a><h3>gtk_places_sidebar_get_nth_bookmark ()</h3>
<pre class="programlisting"><span class="returnvalue">GFile</span> *
gtk_places_sidebar_get_nth_bookmark (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                     <em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
<p>This function queries the bookmarks added by the user to the places sidebar,
and returns one of them.  This function is used by <a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a> to implement
the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-nth-bookmark.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>index of the bookmark to query</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-nth-bookmark.returns"></a><h4>Returns</h4>
<p>The bookmark specified by the index <em class="parameter"><code>n</code></em>
, or
<code class="literal">NULL</code> if no such index exist.  Note that the indices start at 0, even though
the file chooser starts them with the keyboard shortcut "Alt-1". </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-show-connect-to-server"></a><h3>gtk_places_sidebar_get_show_connect_to_server ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_show_connect_to_server
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_places_sidebar_get_show_connect_to_server</code> has been deprecated since version 3.18 and should not be used in newly-written code.</p>
<p>It is recommended to group this functionality with the drives
    and network location under the new 'Other Location' item</p>
</div>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-connect-to-server" title="gtk_places_sidebar_set_show_connect_to_server ()"><code class="function">gtk_places_sidebar_set_show_connect_to_server()</code></a></p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-connect-to-server.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-connect-to-server.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will display a “Connect to Server” item.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-show-connect-to-server"></a><h3>gtk_places_sidebar_set_show_connect_to_server ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_show_connect_to_server
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> show_connect_to_server</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_places_sidebar_set_show_connect_to_server</code> has been deprecated since version 3.18 and should not be used in newly-written code.</p>
<p>It is recommended to group this functionality with the drives
    and network location under the new 'Other Location' item</p>
</div>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should show an item for connecting to a network server;
this is off by default. An application may want to turn this on if it implements
a way for the user to connect to network servers directly.</p>
<p>If you enable this, you should connect to the
<a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-connect-to-server" title="The “show-connect-to-server” signal"><span class="type">“show-connect-to-server”</span></a> signal.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-show-connect-to-server.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_connect_to_server</p></td>
<td class="parameter_description"><p>whether to show an item for the Connect to Server command</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-local-only"></a><h3>gtk_places_sidebar_get_local_only ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_local_only (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-local-only" title="gtk_places_sidebar_set_local_only ()"><code class="function">gtk_places_sidebar_set_local_only()</code></a>.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-local-only.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-local-only.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will only show local files.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-local-only"></a><h3>gtk_places_sidebar_set_local_only ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_local_only (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                   <em class="parameter"><code><span class="type">gboolean</span> local_only</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should only show local files.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-local-only.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>local_only</p></td>
<td class="parameter_description"><p>whether to show only local files</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-show-enter-location"></a><h3>gtk_places_sidebar_get_show_enter_location ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_show_enter_location
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-enter-location" title="gtk_places_sidebar_set_show_enter_location ()"><code class="function">gtk_places_sidebar_set_show_enter_location()</code></a></p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-enter-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-enter-location.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will display an “Enter Location” item.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-14.html#api-index-3.14">3.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-show-enter-location"></a><h3>gtk_places_sidebar_set_show_enter_location ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_show_enter_location
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> show_enter_location</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should show an item for entering a location;
this is off by default. An application may want to turn this on if manually
entering URLs is an expected user action.</p>
<p>If you enable this, you should connect to the
<a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-enter-location" title="The “show-enter-location” signal"><span class="type">“show-enter-location”</span></a> signal.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-show-enter-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_enter_location</p></td>
<td class="parameter_description"><p>whether to show an item to enter a location</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-14.html#api-index-3.14">3.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-show-trash"></a><h3>gtk_places_sidebar_get_show_trash ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_show_trash (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-trash" title="gtk_places_sidebar_set_show_trash ()"><code class="function">gtk_places_sidebar_set_show_trash()</code></a></p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-trash.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-trash.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will display a “Trash” item.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-show-trash"></a><h3>gtk_places_sidebar_set_show_trash ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_show_trash (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                   <em class="parameter"><code><span class="type">gboolean</span> show_trash</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should show an item for the Trash location.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-show-trash.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_trash</p></td>
<td class="parameter_description"><p>whether to show an item for the Trash location</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-get-show-other-locations"></a><h3>gtk_places_sidebar_get_show_other_locations ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_places_sidebar_get_show_other_locations
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>);</pre>
<p>Returns the value previously set with <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-show-other-locations" title="gtk_places_sidebar_set_show_other_locations ()"><code class="function">gtk_places_sidebar_set_show_other_locations()</code></a></p>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-other-locations.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-places-sidebar-get-show-other-locations.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sidebar will display an “Other Locations” item.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-show-other-locations"></a><h3>gtk_places_sidebar_set_show_other_locations ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_show_other_locations
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> show_other_locations</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>sidebar</code></em>
 should show an item for the application to show
an Other Locations view; this is off by default. When set to <code class="literal">TRUE</code>, persistent
devices such as hard drives are hidden, otherwise they are shown in the sidebar.
An application may want to turn this on if it implements a way for the user to
see and interact with drives and network servers directly.</p>
<p>If you enable this, you should connect to the
<a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-other-locations" title="The “show-other-locations” signal"><span class="type">“show-other-locations”</span></a> signal.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-show-other-locations.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_other_locations</p></td>
<td class="parameter_description"><p>whether to show an item for the Other Locations view</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-places-sidebar-set-drop-targets-visible"></a><h3>gtk_places_sidebar_set_drop_targets_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_places_sidebar_set_drop_targets_visible
                               (<em class="parameter"><code><a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>,
                                <em class="parameter"><code><span class="type">GdkDragContext</span> *context</code></em>);</pre>
<p>Make the GtkPlacesSidebar show drop targets, so it can show the available
drop targets and a "new bookmark" row. This improves the Drag-and-Drop
experience of the user and allows applications to show all available
drop targets at once.</p>
<p>This needs to be called when the application is aware of an ongoing drag
that might target the sidebar. The drop-targets-visible state will be unset
automatically if the drag finishes in the GtkPlacesSidebar. You only need
to unset the state when the drag ends on some other widget on your application.</p>
<div class="refsect3">
<a name="gtk-places-sidebar-set-drop-targets-visible.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a places sidebar.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>visible</p></td>
<td class="parameter_description"><p>whether to show the valid targets or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>drag context used to ask the source about the action that wants to
perform, so hints are more accurate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkPlacesSidebar-struct"></a><h3>GtkPlacesSidebar</h3>
<pre class="programlisting">typedef struct _GtkPlacesSidebar GtkPlacesSidebar;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesOpenFlags"></a><h3>enum GtkPlacesOpenFlags</h3>
<p>These flags serve two purposes.  First, the application can call <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-open-flags" title="gtk_places_sidebar_set_open_flags ()"><code class="function">gtk_places_sidebar_set_open_flags()</code></a>
using these flags as a bitmask.  This tells the sidebar that the application is able to open
folders selected from the sidebar in various ways, for example, in new tabs or in new windows in
addition to the normal mode.</p>
<p>Second, when one of these values gets passed back to the application in the
<a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a> signal, it means that the application should
open the selected location in the normal way, in a new tab, or in a new
window.  The sidebar takes care of determining the desired way to open the location,
based on the modifier keys that the user is pressing at the time the selection is made.</p>
<p>If the application never calls <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-open-flags" title="gtk_places_sidebar_set_open_flags ()"><code class="function">gtk_places_sidebar_set_open_flags()</code></a>, then the sidebar will only
use <a class="link" href="GtkPlacesSidebar.html#GTK-PLACES-OPEN-NORMAL:CAPS"><span class="type">GTK_PLACES_OPEN_NORMAL</span></a> in the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a> signal.  This is the
default mode of operation.</p>
<div class="refsect3">
<a name="GtkPlacesOpenFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-PLACES-OPEN-NORMAL:CAPS"></a>GTK_PLACES_OPEN_NORMAL</p></td>
<td class="enum_member_description">
<p>This is the default mode that <a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> uses if no other flags
are specified.  It indicates that the calling application should open the selected location
in the normal way, for example, in the folder view beside the sidebar.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-PLACES-OPEN-NEW-TAB:CAPS"></a>GTK_PLACES_OPEN_NEW_TAB</p></td>
<td class="enum_member_description">
<p>When passed to <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-set-open-flags" title="gtk_places_sidebar_set_open_flags ()"><code class="function">gtk_places_sidebar_set_open_flags()</code></a>, this indicates
that the application can open folders selected from the sidebar in new tabs.  This value
will be passed to the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a> signal when the user selects
that a location be opened in a new tab instead of in the standard fashion.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-PLACES-OPEN-NEW-WINDOW:CAPS"></a>GTK_PLACES_OPEN_NEW_WINDOW</p></td>
<td class="enum_member_description">
<p>Similar to <em class="parameter"><code>GTK_PLACES_OPEN_NEW_TAB</code></em>
, but indicates that the application
can open folders in new windows.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkPlacesSidebar--local-only"></a><h3>The <code class="literal">“local-only”</code> property</h3>
<pre class="programlisting">  “local-only”               <span class="type">gboolean</span></pre>
<p>Whether the sidebar only includes local files.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--location"></a><h3>The <code class="literal">“location”</code> property</h3>
<pre class="programlisting">  “location”                 <span class="type">GFile</span> *</pre>
<p>The location to highlight in the sidebar.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--open-flags"></a><h3>The <code class="literal">“open-flags”</code> property</h3>
<pre class="programlisting">  “open-flags”               <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a></pre>
<p>Modes in which the calling application can open locations selected in the sidebar.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_PLACES_OPEN_NORMAL</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--populate-all"></a><h3>The <code class="literal">“populate-all”</code> property</h3>
<pre class="programlisting">  “populate-all”             <span class="type">gboolean</span></pre>
<p>If :populate-all is <code class="literal">TRUE</code>, the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-populate-popup" title="The “populate-popup” signal"><span class="type">“populate-popup”</span></a> signal
is also emitted for popovers.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-connect-to-server"></a><h3>The <code class="literal">“show-connect-to-server”</code> property</h3>
<pre class="programlisting">  “show-connect-to-server”   <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes a builtin shortcut to a 'Connect to server' dialog.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-desktop"></a><h3>The <code class="literal">“show-desktop”</code> property</h3>
<pre class="programlisting">  “show-desktop”             <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes a builtin shortcut to the Desktop folder.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-enter-location"></a><h3>The <code class="literal">“show-enter-location”</code> property</h3>
<pre class="programlisting">  “show-enter-location”      <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes a builtin shortcut to manually enter a location.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-other-locations"></a><h3>The <code class="literal">“show-other-locations”</code> property</h3>
<pre class="programlisting">  “show-other-locations”     <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes an item to show external locations.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-recent"></a><h3>The <code class="literal">“show-recent”</code> property</h3>
<pre class="programlisting">  “show-recent”              <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes a builtin shortcut for recent files.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-starred-location"></a><h3>The <code class="literal">“show-starred-location”</code> property</h3>
<pre class="programlisting">  “show-starred-location”    <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes an item to show starred files.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar--show-trash"></a><h3>The <code class="literal">“show-trash”</code> property</h3>
<pre class="programlisting">  “show-trash”               <span class="type">gboolean</span></pre>
<p>Whether the sidebar includes a builtin shortcut to the Trash location.</p>
<p>Owner: GtkPlacesSidebar</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkPlacesSidebar-drag-action-ask"></a><h3>The <code class="literal">“drag-action-ask”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">int</span>               actions,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it needs to ask the application
to pop up a menu to ask the user for which drag action to perform.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-drag-action-ask.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actions</p></td>
<td class="parameter_description"><p>Possible drag actions that need to be asked for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GtkPlacesSidebar-drag-action-ask.returns"></a><h4>Returns</h4>
<p> the final drag action that the sidebar should pass to the drag side
of the drag-and-drop operation.</p>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-drag-action-requested"></a><h3>The <code class="literal">“drag-action-requested”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">GdkDragContext</span>   *context,
               <span class="type">GObject</span>          *dest_file,
               <span class="type">gpointer</span>          source_file_list,
               <span class="type">gpointer</span>          user_data)</pre>
<p>When the user starts a drag-and-drop operation and the sidebar needs
to ask the application for which drag action to perform, then the
sidebar will emit this signal.</p>
<p>The application can evaluate the <em class="parameter"><code>context</code></em>
 for customary actions, or
it can check the type of the files indicated by <em class="parameter"><code>source_file_list</code></em>
 against the
possible actions for the destination <em class="parameter"><code>dest_file</code></em>
.</p>
<p>The drag action to use must be the return value of the signal handler.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-drag-action-requested.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p><span class="type">GdkDragContext</span> with information about the drag operation. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gdk.DragContext]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>dest_file</p></td>
<td class="parameter_description"><p><span class="type">GFile</span> with the tentative location that is being hovered for a drop. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gio.File]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>source_file_list</p></td>
<td class="parameter_description"><p>List of <span class="type">GFile</span> that are being dragged. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GLib.List][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GFile][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GtkPlacesSidebar-drag-action-requested.returns"></a><h4>Returns</h4>
<p> The drag action to use, for example, <span class="type">GDK_ACTION_COPY</span>
or <span class="type">GDK_ACTION_MOVE</span>, or 0 if no action is allowed here (i.e. drops
are not allowed in the specified <em class="parameter"><code>dest_file</code></em>
).</p>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-drag-perform-drop"></a><h3>The <code class="literal">“drag-perform-drop”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">GObject</span>          *dest_file,
               <span class="type">gpointer</span>          source_file_list,
               <span class="type">int</span>               action,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when the user completes a
drag-and-drop operation and one of the sidebar's items is the
destination.  This item is in the <em class="parameter"><code>dest_file</code></em>
, and the
<em class="parameter"><code>source_file_list</code></em>
 has the list of files that are dropped into it and
which should be copied/moved/etc. based on the specified <em class="parameter"><code>action</code></em>
.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-drag-perform-drop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_file</p></td>
<td class="parameter_description"><p>Destination <span class="type">GFile</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gio.File]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>source_file_list</p></td>
<td class="parameter_description"><p><span class="type">GList</span> of <span class="type">GFile</span> that got dropped. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GLib.List][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GFile][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>Drop action to perform.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-mount"></a><h3>The <code class="literal">“mount”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">GMountOperation</span>  *mount_operation,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it starts a new operation
because the user clicked on some location that needs mounting.
In this way the application using the <a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> can track the
progress of the operation and, for example, show a notification.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-mount.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mount_operation</p></td>
<td class="parameter_description"><p>the <span class="type">GMountOperation</span> that is going to start.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-20.html#api-index-3.20">3.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-open-location"></a><h3>The <code class="literal">“open-location”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a>  *sidebar,
               <span class="type">GObject</span>           *location,
               <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> open_flags,
               <span class="type">gpointer</span>           user_data)</pre>
<p>The places sidebar emits this signal when the user selects a location
in it.  The calling application should display the contents of that
location; for example, a file manager should show a list of files in
the specified location.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-open-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p><span class="type">GFile</span> to which the caller should switch. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gio.File]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>open_flags</p></td>
<td class="parameter_description"><p>a single value from <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> specifying how the <em class="parameter"><code>location</code></em>
should be opened.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-populate-popup"></a><h3>The <code class="literal">“populate-popup”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>        *container,
               <span class="type">GFile</span>            *selected_item,
               <span class="type">GVolume</span>          *selected_volume,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when the user invokes a contextual
popup on one of its items. In the signal handler, the application may
add extra items to the menu as appropriate. For example, a file manager
may want to add a "Properties" command to the menu.</p>
<p>It is not necessary to store the <em class="parameter"><code>selected_item</code></em>
 for each menu item;
during their callbacks, the application can use <a class="link" href="GtkPlacesSidebar.html#gtk-places-sidebar-get-location" title="gtk_places_sidebar_get_location ()"><code class="function">gtk_places_sidebar_get_location()</code></a>
to get the file to which the item refers.</p>
<p>The <em class="parameter"><code>selected_item</code></em>
 argument may be <code class="literal">NULL</code> in case the selection refers to
a volume. In this case, <em class="parameter"><code>selected_volume</code></em>
 will be non-<code class="literal">NULL</code>. In this case,
the calling application will have to <code class="function">g_object_ref()</code> the <em class="parameter"><code>selected_volume</code></em>
 and
keep it around to use it in the callback.</p>
<p>The <em class="parameter"><code>container</code></em>
 and all its contents are destroyed after the user
dismisses the popup. The popup is re-created (and thus, this signal is
emitted) every time the user activates the contextual menu.</p>
<p>Before 3.18, the <em class="parameter"><code>container</code></em>
 always was a <a class="link" href="GtkMenu.html" title="GtkMenu"><span class="type">GtkMenu</span></a>, and you were expected
to add your items as <a href="GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItems</span></a>. Since 3.18, the popup may be implemented
as a <a class="link" href="GtkPopover.html" title="GtkPopover"><span class="type">GtkPopover</span></a>, in which case <em class="parameter"><code>container</code></em>
 will be something else, e.g. a
<a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a>, to which you may add <a href="GtkModelButton.html#GtkModelButton-struct"><span class="type">GtkModelButtons</span></a> or other widgets, such as
<span class="type">GtkEntries</span>, <a href="GtkSpinButton.html#GtkSpinButton-struct"><span class="type">GtkSpinButtons</span></a>, etc. If your application can deal with this
situation, you can set <span class="type">“populate-all”</span> to <code class="literal">TRUE</code> to request
that this signal is emitted for populating popovers as well.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-populate-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>container</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkMenu.html" title="GtkMenu"><span class="type">GtkMenu</span></a> or another <a class="link" href="GtkContainer.html" title="GtkContainer"><span class="type">GtkContainer</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gtk.Widget]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>selected_item</p></td>
<td class="parameter_description"><p><span class="type">GFile</span> with the item to which
the popup should refer, or <code class="literal">NULL</code> in the case of a <em class="parameter"><code>selected_volume</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gio.File][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>selected_volume</p></td>
<td class="parameter_description"><p><span class="type">GVolume</span> if the selected
item is a volume, or <code class="literal">NULL</code> if it is a file. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gio.Volume][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-show-connect-to-server"></a><h3>The <code class="literal">“show-connect-to-server”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it needs the calling
application to present an way to connect directly to a network server.
For example, the application may bring up a dialog box asking for
a URL like "sftp://ftp.example.com".  It is up to the application to create
the corresponding mount by using, for example, <code class="function">g_file_mount_enclosing_volume()</code>.</p>
<div class="warning">
<p><code class="literal">GtkPlacesSidebar::show-connect-to-server</code> has been deprecated since version 3.18 and should not be used in newly-written code.</p>
<p>use the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-other-locations" title="The “show-other-locations” signal"><span class="type">“show-other-locations”</span></a> signal
    to connect to network servers.</p>
</div>
<div class="refsect3">
<a name="GtkPlacesSidebar-show-connect-to-server.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-show-enter-location"></a><h3>The <code class="literal">“show-enter-location”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it needs the calling
application to present an way to directly enter a location.
For example, the application may bring up a dialog box asking for
a URL like "http://http.example.com".</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-show-enter-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-14.html#api-index-3.14">3.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-show-error-message"></a><h3>The <code class="literal">“show-error-message”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">char</span>             *primary,
               <span class="type">char</span>             *secondary,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it needs the calling
application to present an error message.  Most of these messages
refer to mounting or unmounting media, for example, when a drive
cannot be started for some reason.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-show-error-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary</p></td>
<td class="parameter_description"><p>primary message with a summary of the error to show.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary</p></td>
<td class="parameter_description"><p>secondary message with details of the error to show.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-show-other-locations"></a><h3>The <code class="literal">“show-other-locations”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it needs the calling
application to present a way to show other locations e.g. drives
and network access points.
For example, the application may bring up a page showing persistent
volumes and discovered network addresses.</p>
<div class="warning">
<p><code class="literal">GtkPlacesSidebar::show-other-locations</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>use the <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-show-other-locations-with-flags" title="The “show-other-locations-with-flags” signal"><span class="type">“show-other-locations-with-flags”</span></a>
which includes the open flags in order to allow the user to specify to open
in a new tab or window, in a similar way than <a class="link" href="GtkPlacesSidebar.html#GtkPlacesSidebar-open-location" title="The “open-location” signal"><span class="type">“open-location”</span></a></p>
</div>
<div class="refsect3">
<a name="GtkPlacesSidebar-show-other-locations.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-show-other-locations-with-flags"></a><h3>The <code class="literal">“show-other-locations-with-flags”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a>  *sidebar,
               <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> open_flags,
               <span class="type">gpointer</span>           user_data)</pre>
<p>The places sidebar emits this signal when it needs the calling
application to present a way to show other locations e.g. drives
and network access points.
For example, the application may bring up a page showing persistent
volumes and discovered network addresses.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-show-other-locations-with-flags.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>open_flags</p></td>
<td class="parameter_description"><p>a single value from <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> specifying how it should be opened.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-20.html#api-index-3.20">3.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-show-starred-location"></a><h3>The <code class="literal">“show-starred-location”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a>  *sidebar,
               <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> open_flags,
               <span class="type">gpointer</span>           user_data)</pre>
<p>The places sidebar emits this signal when it needs the calling
application to present a way to show the starred files. In GNOME,
starred files are implemented by setting the nao:predefined-tag-favorite
tag in the tracker database.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-show-starred-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>open_flags</p></td>
<td class="parameter_description"><p>a single value from <a class="link" href="GtkPlacesSidebar.html#GtkPlacesOpenFlags" title="enum GtkPlacesOpenFlags"><span class="type">GtkPlacesOpenFlags</span></a> specifying how the
starred file should be opened.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: 3.22.26</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlacesSidebar-unmount"></a><h3>The <code class="literal">“unmount”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> *sidebar,
               <span class="type">GMountOperation</span>  *mount_operation,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The places sidebar emits this signal when it starts a new operation
because the user for example ejected some drive or unmounted a mount.
In this way the application using the <a class="link" href="GtkPlacesSidebar.html" title="GtkPlacesSidebar"><span class="type">GtkPlacesSidebar</span></a> can track the
progress of the operation and, for example, show a notification.</p>
<div class="refsect3">
<a name="GtkPlacesSidebar-unmount.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mount_operation</p></td>
<td class="parameter_description"><p>the <span class="type">GMountOperation</span> that is going to start.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-20.html#api-index-3.20">3.20</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlacesSidebar.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>